ci: add PyPI publish workflow and standardize README#279
Open
sudsali wants to merge 1 commit into
Open
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
sudsali
changed the title
publish.yml — workflow_dispatch release mirroring awslabs/deequ: the operator supplies the release version, the workflow sets it (poetry version + sync pydeequ/__init__.py), builds, and publishes to PyPI, then tags the released commit and opens a version-bump PR. Real uploads run in the protected pypi-release environment (required reviewer, dispatched from master); dry runs build only. PyPI token fetched from Secrets Manager via OIDC, masked, passed via POETRY_PYPI_TOKEN_PYPI env (never argv/output/file). README — standardize to deequ/dqdl: drop the Announcements section, fix section ordering, end with Contributing -> Security -> License. This PR adds the release tooling only; it does not itself bump the version or publish — the workflow sets the version at release time.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds automated PyPI publishing for python-deequ (previously manual) and standardizes the README. Mirrors awslabs/deequ's release flow.
What Changes
.github/workflows/publish.yml— aworkflow_dispatchrelease: the operator supplies the release version, the workflow sets it, builds, publishes to PyPI, then tags the release and opens a follow-up version-bump PR.(The repo version is intentionally left unchanged here — the release workflow sets it at publish time, so there is no pre-bump.)
Publish flow
workflow_dispatchwithrelease_version+dry_run(defaulttrue).pyproject.toml+pydeequ/__init__.pyare set and asserted to agree with the built wheel, then published.v<version>, pinned to the exact published commit — never before the upload) and a version-bump PR is opened.Releasing (after merge)
Real releases must be dispatched from
master(the deployment environment permits only that branch):masterwithrelease_version(e.g.1.6.0) anddry_rununchecked.v<version>tag is created, and a version-bump PR opens.Use a
dry_runfirst (from any branch) to smoke-test the build.Rollback
Revert this PR — the publish workflow is removed; no data or state migration.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.